Child Screening
Domain Message Specification

Version: 2.1; Status: RC3

NewBornHearingScreening Tabular View

COCD_TP146003GB02
NewBornHearingScreening

This template class constrains the CDA observation entry class.

This class represents a newborn hearing screening event.
Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:SnomedCT } )
{ Fixed="252957005" }

Model Attribute Description

The HL7 attribute code uses a code from SNOMED CT to describe this class as a newborn hearing screening event.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "252957005"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the code. It is recommended that the preferred term is used to populate this attribute
[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 attribute effectiveTime is used to indicate when the newborn hearing screening event was completed.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time that the newborn hearing screening event was completed using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify each instance of a newborn hearing screening event.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146003GB02#NewBornHearingScreening" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146003GB02#NewBornHearingScreening"
[1..1] [M] value (CD { CWE:NewBornHearingScreeningOutcomeSnCT } )

Model Attribute Description

The HL7 attribute value uses a code from the NewBornHearingScreeningOutcomeSnCT vocabulary to describe this value as a newborn hearing screening outcome. This value is associated with the SNOMED CT concept carried in the HL7 attribute code of this class.

Implementation in XML Instance

The Concept Descriptor (CD) data type shall be used to carry this information in the XML element value as follows:

  • The XML attribute code shall contain the value from the NewBornHearingScreeningOutcomeSnCT vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the code stated in the NewBornHearingScreeningOutcomeSnCT vocabulary. It is recommended that the preferred term is used to populate this attribute
  • The XML element translation may be populated as follows to support alternate coding system representation of the same information.
  • For alternate coding systems (schemes):
    • The XML attribute code shall contain the value from the that coding scheme.
    • The XML attribute codeSystem shall contain the OID for that coding scheme.
    • The XML attribute displayName may carry the description associated with the code.
[0..1] author

This template class constrains the CDA author class.

The author of this information must be included if the author is different to the document (inherited) author.

If there is no known author for the information held on the source system then:

  • The information may be included and the document author will be deemed to be the author (by inheritance). The author should be asked to decide whether this is acceptable of not.
  • If the document author does not want to be considered as the author of the information then information must not be included in the document.
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode describes this class as an author participation.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "AUT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd in the actRelationships is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

The XML attribute contextControlCode shall contain the value " OP".
[1..1] [M] contentId (II) { "NPFIT-000196#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The XML attribute extension shall contain one of the allowed template artefact identifiers
[1..1] [M] functionCode (CV { CNE:AuthorFunctionType } )
{ Fixed="OA" }

Model Attribute Description

The HL7 attribute functionCode uses a code from the vocabulary AuthorFunctionType to describe the function of the author

Implementation in XML Instance

The Coded Plain data type flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element functionCode as follows:

  • The XML attribute code is fixed to "OA"
  • The XML attribute codeSystem is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.17.178"
  • The XML attribute displayName is fixed to the author's function name "Originating Author"
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146003GB02#author" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146003GB02#author"
[1..1] [R] time (TS)

Model Attribute Description

The HL7 attribute time is used to define the time that the author originally recorded the newborn hearing examination.

Implementation in XML Instance

The XML attribute value of the XML element time shall be populated with the time that the author recorded the information using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

Where no time is recorded or available then:

The XML attribute nullFlavor of the XML element time shall contain the value "UNK".

[1..1] participant (AuthorChoice)
A link to the choice of authors.
[0..1] entryRelationship2

This template class constrains the CDA entryRelationship entry class.

This class is a component class used to link to the audiology test referral.
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="COMP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a component.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "COMP".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146003GB02#entryRelationship2" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146003GB02#entryRelationship2"
[1..1] audiologyReferral (AudiologyReferral)
A link to the audiology referral.
AuthorChoice
A choice of author templates.
Used by: NewBornHearingScreening
[1..1] : Template1
An abstract placeholder for templates of authors.
AudiologyReferral

This template class constrains the CDA Act entry class.

This class is used to represent an audiology test referral.
Used by: NewBornHearingScreening
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="PROC" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a procedure.

Implementation in XML Instance

  • The XML attribute classcode is fixed to "PROC".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a procedure event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:SnomedCT } )
{ Fixed="309619003" }

Model Attribute Description

The HL7 attribute code uses a code from SNOMED CT to describe this class as a child referral for audiology.

Implementation in XML Instance

The Coded Value(CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the fixed value "309619003"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the code. It is recommended that the preferred term is used to populate this attribute.
[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 attribute effectiveTime is used to define the time the referral for an audiology test was made.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time that the audiology test referral was made using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minutes
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

[1..1] [M] templateId (II)
{ Fixed="COCD_TP146003GB02#audiologyReferral" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146003GB02#audiologyReferral"